home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 26.zip / BS1 part 26 / The Director Toolkit v1.0.adf / Programs / Text / docs < prev   
Text File  |  1987-02-25  |  7KB  |  179 lines
  1. |r1
  2. |c7|f1|t1Text Reader|c3|f0|t0|r1
  3. The text reader is the program that you have been using to read
  4. the documentation files on this disk.  The script for the text
  5. reader is provided so that you may adapt it to your own requirements.|r1
  6.  
  7. When you run the text reader, it looks for a file called |c7"docs"|c3 in
  8. the same directory that the text reader is in, and proceeds to display
  9. the text contained in that file.|r1
  10.  
  11. The text reader will automatically word-wrap as it displays
  12. the text, and recognizes some imbedded signal characters 
  13. so that you can change fonts, auto-center, and change text
  14. color and style.
  15. |e
  16.  
  17. When you build a |c7"docs"|c3 file for the text reader, you do not have to
  18. worry about deciding where to break the lines of text into individual
  19. lines, as the word wrap capability of the text reader will decide
  20. that for you.  You can enter text in most any haphazard way, and
  21. the text reader will straighten it out when it displays on the
  22. screen.  If you want to break a line for a new paragraph, a single
  23. blank line will cause a break to a new line.  Two blank lines will
  24. cause a blank line between paragraphs, or you can use the "r" command
  25. to insert a new line.|r1
  26.  
  27. The character |c7'|-||'|c3 is reserved for signalling, and will be 
  28. followed by another character or characters specifying what function is 
  29. to be performed.
  30. |e
  31. |r2
  32. The provided functions are:|r1
  33.  
  34. |c7|+4 ||e|+4end of page|r1
  35. |+4 ||f#|+3select font number #|r1
  36. |+4 ||c#|+3change to text color #|r1
  37. |+4 ||s#|+3select style #|r1
  38. |+4 ||t#|+3centering on/off|r1
  39. |+4 ||-|+4backspace|r1
  40. |+4 ||+#|+3required spacing|r1
  41. |+4 ||r#|+3insert new lines|r1
  42. |+4 |||||+5output a |||c3|r1
  43. |e
  44.  
  45. One of the best ways to see how you would build text for the text
  46. reader is to examine some of the |c7"docs"|c3 files directly in any of the
  47. directories on this disk which contain the |c7README|c3 icon.  All the
  48. |c7README|c3 icons represent copies of the text reader's |c7.film|c3 file, 
  49. renamed to the appropriate name for the text being read.  Otherwise, they 
  50. are all identical.|r1
  51.  
  52. The background screen for the text reader is found on the toolkit disk
  53. in the directory |c7ToolKit:pictures|c3 and is called |c7"framer"|c3|-.
  54. You can 
  55. modify this to suit, though it should probably be a medium-res (640x200)
  56. image.  By changing the palette or border pattern of this image, you will 
  57. modify all of the text screens found on this disk.
  58. |e
  59.  
  60. Here are the specifics on each of the commands:|r1
  61.  
  62. |c7||e  End Of Page|c3|r1
  63. You should use this command to signal here is where you want a break
  64. to the next screen.  While it is not required that you use this to
  65. signify page breaks, you will get much better results if all the
  66. page breaks are specified by this command.|r1
  67.  
  68. A good way to determine where you need to place the page breaks is to
  69. first type in your text information, then display it with the text reader
  70. with no page signals.  The text reader will automatically break pages
  71. when the text gets to the end of the screen.  You can then decide exactly
  72. where you would like the page break to occur, and go back into the 
  73. |c7"docs"|c3
  74. file and add the |c7||e|c3 command accordingly.|r1
  75. |e
  76. |r3
  77. |c7||f#  Select Font|c3|r1
  78. This command will allow you to specify a change in fonts.  Currently,
  79. only two fonts are implemented in the text reader, |c7Topaz 8|c3
  80. and |c7Topaz 9|c3|-.
  81. You can add fonts to the reader by adding |c7LOADFONT|c3|-s of them to 
  82. the text 
  83. reader script and regenerating the text reader's |c7.film|c3 file.  
  84. Follow 
  85. the examples in the script of the Topaz fonts for how to do this.|r1
  86. |e
  87. |r3
  88. Font #1 is |c7Topaz 8|c3|-, and Font #2 |c7Topaz 9|c3|-.  Font changing 
  89. commands will appear something like this in a |c7"docs"|c3 file:|r1
  90.  
  91. |c7|+8because we have ||f2discovered|-||f1 that|c3|r1
  92.  
  93. which will cause the word "discovered" to be in |c7Topaz 9|c3 with the rest
  94. of the text in |c7Topaz 8|c3like this:|r1
  95.  
  96. |c7|+8because we have |f2discovered|f1 that|c3|r1
  97.  
  98. |e
  99.  
  100. |c7||c#  Set Color|c3|r1
  101. You can select a different palette color for text by 
  102. using the |c7|+1||c#|c3 command.  You can change to any of the
  103. colors in the palette of the
  104. |c7ToolKit:pictures/framer|c3 background file.  Since this 
  105. file is currently an |c78|c3 color
  106. image, you can specify color numbers |c70-7|c3 to pick any one of 
  107. the |c78|c3 colors
  108. available.  You can change the color selection by using a (preferably
  109. non-HAM) paint program to adjust the palette of the picture, and you can
  110. even convert it to a |c716|c3 color image allowing you to use color numbers 
  111. |c70-9|c3|-.  Currently colors |c710|c3 and over are not allowable as 
  112. the color command
  113. only allows one digit for color selection.  This can be modified in the
  114. text reader script by the zealous.|r1
  115. |e
  116. |r2
  117. The default text color is |c73|c3|-.  Here is our example with a color 
  118. change instead of a font change:|r1
  119.  
  120. |c7|+8because we have ||c1discovered|-||c3 that|c3|r1
  121.  
  122. Or, with both a color and font change:|r1
  123.  
  124. |c7|+8because we have ||f2|-||c4discovered|-||f1|-||c1 that|c3|r1
  125. |e
  126. |r2
  127. |c7||s#  Changing Text Style|c3|r1
  128. You can change text style to underline, italic or Bold with the 
  129. |c7||s|c3 command:
  130. |r1
  131.  
  132. |c7|+80 - Normal|r1
  133. |+81 - Underline|r1
  134. |+82 - Bold|r1
  135. |+83 - Italic|c3|r1
  136. |e
  137. So, to convert our above example to bolded text, here is what you
  138. would enter into the |c7"docs"|c3 file:|r1
  139.  
  140. |c7|+8because we have ||s2discovered|-||s0 that|c3|r1
  141.  
  142. |c7||t#  Centering On/Off|c3|r1
  143. You can turn centering off and on with |c7||t1|c3 to turn it on, and 
  144. |c7||t0|c3 to turn it off.|r1
  145.  
  146. |c7||- Backspace|c3|r1
  147. Sometimes it is useful to override spaces that follow words that are
  148. automatically output by the word-wrap portion of the text reader.
  149. If you find places in your document file where you are finding the
  150. output has a space where you don't want it, you can follow that
  151. portion of your text with the |c7||-|c3 signal, which will cause a 
  152. backspace to occur.|r1
  153. |e
  154. |c7||+#    Required Spacing|c3|r1
  155. Sometimes you want some spaces which may otherwise be automatically
  156. removed by the word-wrap function of the text reader.  By inserting
  157. |c7||+4|c3 for example, you can add |c74|c3 spaces that will not be 
  158. removed by
  159. word wrapping.  You are allowed up to |c710|c3 spaces, |c71-9|c3
  160. and |c70|c3 (for 10).
  161. If you need more, you can combine more than one required space command
  162. in a row, such as:  |c7||+0|-||+4|c3 for |c714|c3 spaces.|r1
  163.  
  164. |c7||r#  Insert New Lines|c3|r1
  165. You may wish to interrupt the normal word-wrap so that you can start
  166. a new sentence on the next line, or even leave a space between
  167. paragraphs.  You can do this by placing a |c7||r1|c3 at the end of the text
  168. after which you wish a new line to start.  By using |c7||r2|c3, you can 
  169. then leave a blank line between paragraphs.  An extra blank line in
  170. your |c7"docs"|c3 file will have a similar effect to 
  171. the |c7||r1|c3 command.|r1
  172. |e
  173. |r3
  174. |c7|||||+3Output a |||c3|r1
  175. You may need to output the vertical bar symbol at times, and since this
  176. character is otherwise reserved for the signal character for the special
  177. text functions, you will need to enter it twice to output the character
  178. directly, so that it is not interpreted as a command.
  179.